# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('../src'))#指向src目录

# -- Project information -----------------------------------------------------

project = 'K2000'          #  项目名称
copyright = '2022, sen'                 #  版权声明
author = 'sen'                          #  作者名

# The full version, including alpha/beta/rc tags
release = 'v1.0'                        #  版本 

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['recommonmark',
'sphinx_markdown_tables',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax']      # 扩展模块名

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']                             # 模板路径

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'                                   # 代码语法高亮

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'zh_CN'                                          # 语言

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []       


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'                             # HTML 主题

html_favicon = '../images/favicon.jpg'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# 如果为true, 则rest源包含在HTML构建中:file:_sources/{name}。默认为“True”。
html_copy_source=False  #关闭右上角的查看源码

html_theme_options = {
    
    'logo_only': True,
    
}

html_logo = '../images/logo.png' 